<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Whisper: IBitSource Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Whisper
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">IBitSource Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="IBitSource" -->
<p>abstract steg payload bit source  
 <a href="classIBitSource.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="bit__source_8h_source.html">bit_source.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for IBitSource:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classIBitSource.png" usemap="#IBitSource_map" alt=""/>
  <map id="IBitSource_map" name="IBitSource_map">
<area href="classCByteBuilder.html" title="Assembles bits to bytes. Splits bytes to bits." alt="CByteBuilder" shape="rect" coords="0,56,102,80"/>
<area href="classCDummyBuilder.html" alt="CDummyBuilder" shape="rect" coords="112,56,214,80"/>
<area href="classCFrameBuilder.html" title="Assembles bits to a frame. Splits a frame to bits." alt="CFrameBuilder" shape="rect" coords="224,56,326,80"/>
</map>
 </div></div>

<p><a href="classIBitSource-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIBitSource.html#ac67c3d7cb4cc7525a5d934800805fbf6">IBitSource</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIBitSource.html#a59a71db94c8721a915a8e4baa9b7c6b8">~IBitSource</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIBitSource.html#a8033470e96c8810b748f42ce68abaa3a">getBit</a> (bool &amp;pReadBit)=0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">get a data bit from the byte buffer  <a href="#a8033470e96c8810b748f42ce68abaa3a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIBitSource.html#a2af07e746032f6506d94f9a487c6870e">putBit</a> (bool pWriteBit)=0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">put a data bit into the byte buffer  <a href="#a2af07e746032f6506d94f9a487c6870e"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>abstract steg payload bit source </p>
<dl class="author"><dt><b>Author:</b></dt><dd>gpitsch and rpoisel </dd></dl>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac67c3d7cb4cc7525a5d934800805fbf6"></a><!-- doxytag: member="IBitSource::IBitSource" ref="ac67c3d7cb4cc7525a5d934800805fbf6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IBitSource::IBitSource </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a59a71db94c8721a915a8e4baa9b7c6b8"></a><!-- doxytag: member="IBitSource::~IBitSource" ref="a59a71db94c8721a915a8e4baa9b7c6b8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual IBitSource::~IBitSource </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8033470e96c8810b748f42ce68abaa3a"></a><!-- doxytag: member="IBitSource::getBit" ref="a8033470e96c8810b748f42ce68abaa3a" args="(bool &amp;pReadBit)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int IBitSource::getBit </td>
          <td>(</td>
          <td class="paramtype">bool &amp;&#160;</td>
          <td class="paramname"><em>pReadBit</em></td><td>)</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>get a data bit from the byte buffer </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 for more steg payload and 0 for no more steg payload (EOF) </dd></dl>

<p>Implemented in <a class="el" href="classCFrameBuilder.html#a39f7b14910de9836cf9a12b5b6140260">CFrameBuilder</a>, <a class="el" href="classCByteBuilder.html#a44d8333f2afb474e78cc12f05fce927d">CByteBuilder</a>, and <a class="el" href="classCDummyBuilder.html#a57174b75a42c0e946d84d379e0215bb8">CDummyBuilder</a>.</p>

</div>
</div>
<a class="anchor" id="a2af07e746032f6506d94f9a487c6870e"></a><!-- doxytag: member="IBitSource::putBit" ref="a2af07e746032f6506d94f9a487c6870e" args="(bool pWriteBit)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool IBitSource::putBit </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>pWriteBit</em></td><td>)</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>put a data bit into the byte buffer </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if everything is ok, false tells the embedding engine to resynchronize </dd></dl>

<p>Implemented in <a class="el" href="classCFrameBuilder.html#a27a6a17455cd0adc52264f64c9fa794f">CFrameBuilder</a>, <a class="el" href="classCByteBuilder.html#a104ad4c0f9efb592a6d1b43cfe3ba63b">CByteBuilder</a>, and <a class="el" href="classCDummyBuilder.html#ab77c11f16a2a9050b48d52a29561e043">CDummyBuilder</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="bit__source_8h_source.html">bit_source.h</a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 25 2012 22:00:47 for Whisper by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
